GET api/entity/{entitytype}/{id}?columns[0]={columns[0]}&columns[1]={columns[1]}
Returns the Item with specified oid and type
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| entitytype | string |
Required |
|
| id | integer |
Required |
|
| columns | Collection of string |
Required |
Body Parameters
None.
Response Information
Response Formats
application/json
Sample:
[
{
"LastModifiedBy": 1,
"ClosedDateTime": "0001-01-01T00:00:00-07:00",
"IncidentRequestAttachmentRecords_link": "api/entity/iincidentrequest/39/IncidentRequestAttachmentRecords",
"BusinessHoursToApply": "",
"InstanceOperations": 18446744073709552000,
"ActualDuration": "00:00:00",
"LastApprovalSequence": 0,
"AllowedActions": "Add,AdministerModule,Edit,Edit Own,View,ViewOwn,ViewTeam,Email,Print,View Audit Trail,Close,Resubmit,Requeue,More Info,Delete,Reopen,Promote,EmailReq,Submit,Handle Owner Change,Resolve Promotion,Accept,Resolution Failed,Send,Copy,Resolve",
"ActualCompleteDate": "0001-01-01T00:00:00-07:00",
"ModifiedApprovalPhases": null,
"CreatedDateTime": "2015-04-13T08:55:15.9-06:00",
"EffectiveRoleID": 2,
"CorrespondenceInfo": "",
"SearchCriteria_Column_Temp": null,
"AttachmentCount": 0,
"BusinessTimeToResolve": "00:00:00",
"ActiveTabOnForm": "",
"ItemID": "IR-0000039",
"Cost": 0,
"Priority": 1,
"ItemOwner": null,
"Level": null,
"SLAHiddenStage": "",
"IncidentRequestEntityDependencyLinks_link": "api/entity/iincidentrequest/39/IncidentRequestEntityDependencyLinks",
"IncidentRequestEntityReliesUponLinks_link": "api/entity/iincidentrequest/39/IncidentRequestEntityReliesUponLinks",
"Category": null,
"ApprovalPhaseName": "",
"Department": null,
"Urgency": 1,
"LastAccessedBy": 1,
"ID": 39,
"LaborCost": 0,
"Status": "New",
"IncidentRequestTasks_link": "api/entity/iincidentrequest/39/IncidentRequestTasks",
"Requester": 1,
"LastModifiedDateTime": "2015-04-27T13:17:26.22-06:00",
"SLAStage": "",
"ImpactedResourcesPIT": "",
"Approved": false,
"eTag": 131,
"LocationPIT": null,
"ActualStartDate": "0001-01-01T00:00:00-07:00",
"SubmitDate": "2015-04-22T18:49:28.21-06:00",
"StartedDateTime": "0001-01-01T00:00:00-07:00",
"VIP": false,
"ImpactedUsersAndGroupsPIT": "",
"IncidentRequestTypeFullPathPIT": "3 - Work Request",
"DeniedActions": "",
"ResourceCost": 0,
"Impact": 1,
"CurrentApprovalSequence": 0,
"TimeLine": "New;In-Progress;Pending Close;Closed",
"IncidentRequestImpactedResourceRef_link": "api/entity/iincidentrequest/39/IncidentRequestImpactedResourceRef",
"TimeLineState": "New",
"IncidentRequestHistoryRecords_link": "api/entity/iincidentrequest/39/IncidentRequestHistoryRecords",
"ShowTemplateDropDown": true,
"Sentiment": 0,
"CloseType": null,
"PromoteType": null,
"EmailPIT": "",
"ActualEffort": "00:00:00",
"Summary": "Updated Test Ticket",
"Origin": null,
"AllInSequenceMustApprove": true,
"AssignedTo": null,
"ImpactedBusinessServicesPIT": "",
"IncidentRequestImpactedUserGroupRef_link": "api/entity/iincidentrequest/39/IncidentRequestImpactedUserGroupRef",
"LocationNamePIT": "",
"IsInBusinessTime": true,
"OwningTeam": null,
"CompletedDate": "0001-01-01T00:00:00-07:00",
"DueDate": "2015-04-21T23:59:00-06:00",
"SLAExceeded": false,
"Creator": 1,
"IncidentRequestEntityAuditLogs_link": "api/entity/iincidentrequest/39/IncidentRequestEntityAuditLogs",
}
]
Example Code in C#
//REQUEST
try
{
string sessionId = set to the sessionId that was received on login;
string entitytype = type of the entity to get
int id = id of the entity
string uri = string.format("http://localhost/cgrestapi/api/entity/{0}/{1}", entitytype, id);
HttpWebRequest webRequest = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(uri);
//Assumption: CGRestAPI is configured to use WIA
webRequest.Credentials = CredentialCache.DefaultCredentials;
webRequest.Method = "GET";
webRequest.ContentType = "application/json";
webRequest.Headers.Add("sessionid", sessionId);
HttpWebResponse httpWebResponse = (System.Net.HttpWebResponse)webRequest.GetResponse();
Stream responseStream = httpWebResponse.GetResponseStream();
using (var streamReader = new StreamReader(responseStream))
{
var result = JsonConvert.DeserializeObject(streamReader.ReadToEnd());
if (result != null && result is Newtonsoft.Json.Linq.JArray)
{
//do something with the result
}
}
}
catch (Exception ex)
{
HttpWebResponse resp = ((System.Net.HttpWebResponse)(((System.Net.WebException)(ex)).Response));
using (var streamReader = new StreamReader(resp.GetResponseStream()))
{
string respMesg = streamReader.ReadToEnd();
string status = resp.StatusDescription;
}
}